home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / dev / misc / butclass10.lha / ButClass10 / Doc / ButClass.doc next >
Text File  |  1995-09-01  |  4KB  |  151 lines
  1.  
  2.                File: butclass.doc
  3.         Description: butclass documentation.
  4.           Copyright: (C) Copyright 1995 Doguet Emmanuel.
  5.                      All Rights Reserved.
  6.  
  7. ------------------------------------------------------------------------------
  8.  
  9. TABLE OF CONTENTS
  10.  
  11. butclass/--background--
  12. butclass/Methods
  13. butclass/Attributes
  14.  
  15. butclass/--background--                                 butclass/--background--
  16.  
  17.     NAME
  18.         Class:              butclass
  19.         Superclass:         baseclass
  20.         Include File:       "butclass.h"
  21.  
  22.     FUNCTION
  23.         To  provide you a new button class with new features.
  24.         You can with it SET LABELS, LABEL-COLOR, FRAME COLOR ON THE FLY.
  25.         It allow you too, to do some justification for labels.
  26.  
  27.         Objects from this class send out the  following  attribute  pairs  in
  28.         their notification messages:
  29.  
  30.         GA_ID                   - Gadget object ID.
  31.  
  32.     NOTE
  33.         This class is provided as a link-library. 2 versions,  for  DICE  and
  34.         for SAS/C.
  35.  
  36.         Also your program must open the following libraries:
  37.  
  38.         intuition.library       - V37 or better.
  39.         graphics.library        - V37 or better.
  40.         utility.library         - V37 or better.
  41.         bgui.library            - V39 or better.
  42.         keymaps.library         -
  43.  
  44.         Ofcourse these libraries must remain open until you  are  done  using
  45.         the class.
  46.  
  47.  
  48. butclass/Methods butclass/Methods
  49.  
  50.     NEW METHODS
  51.         None.
  52.  
  53.     CHANGED METHODS
  54.         None.
  55.  
  56. butclass/Attributes                                     butclass/Attributes
  57.  
  58.     NOTE
  59.         All baseclass attributes are also valid for this class.
  60.  
  61.  
  62.     NAME
  63.         BUT_Label --    ( UBYTE * )
  64.  
  65.     FUNCTION
  66.         Set  the  labels  used  for  the   button.   This   must   point   to
  67.         NULL-terminated string pointer.
  68.         For set an underscore, use the '_' caracter like: "_Ok".
  69.         
  70.  
  71.     Default is NULL -   Applicability is (ISG)
  72.  
  73.  
  74.  
  75.     NAME
  76.         BUT_ClipText -- ( BOOL )
  77.  
  78.     FUNCTION
  79.         If TRUE, the width of the button can be smaller than the width of the
  80.         button-label.
  81.  
  82.     Default is FALSE -   Applicability is (IG)
  83.  
  84.  
  85.  
  86.     NAME
  87.         BUT_Justify --  ( BOOL )
  88.  
  89.     FUNCTION
  90.         If TRUE, the button will be in justification mode. The  class  search
  91.         in  the  label-string the BSEQ_J value, and do a justification at the
  92.         placement of all BSEQ_J values.
  93.  
  94.         eg: label= BSEQ_J "Hello" BJEQ_J "Jan" BJEQ_J
  95.  
  96.         will do:      **********************
  97.                       *    Hello    Jan    *
  98.                       **********************
  99.  
  100.  
  101.         Default is FALSE. Applicability is (IG).
  102.  
  103.  
  104.  
  105.     NAME
  106.         BUT_LabelPen --     ( ULONG )
  107.  
  108.     FUNCTION
  109.         Set the color of the label.
  110.  
  111.     Applicability is (ISG).
  112.  
  113.  
  114.  
  115.     NAME
  116.         BUT_SelectedLabelPen --     ( ULONG )
  117.  
  118.     FUNCTION
  119.         Set the color of the label when button was selected.
  120.  
  121.     Applicability is (ISG).
  122.  
  123.  
  124.  
  125.     NAME
  126.         BUT_TextFont --             ( struct TextFont * )
  127.  
  128.     FUNCTION
  129.         Font of button. Must be opened before with OpenDiskFont.
  130.  
  131.     Applicability is (I).
  132.  
  133.  
  134.     NAME
  135.         BUT_Underscore --             ( ULONG )
  136.  
  137.     FUNCTION
  138.  
  139.         Set or get the character that marks the character to be
  140.         undercored.
  141.         Normally the underscored character is used to mark a key
  142.         which can be used to control gadget. Example:
  143.  
  144.         BUT_Underscore, '_'
  145.  
  146.         Will underscore the 'O' character in the following label:
  147.  
  148.          "_Open"
  149.  
  150.     Default is 0. Applicability is (I).
  151.